home *** CD-ROM | disk | FTP | other *** search
/ Die Ultimative Software-P…i Collection 1996 & 1997 / Die Ultimative Software-Pakete CD-ROM fur Atari Collection 1996 & 1997.iso / tt / videodat / lharc.doc < prev    next >
Encoding:
Text File  |  1996-09-18  |  20.3 KB  |  443 lines

  1.        _________________________________________________________________
  2.       /                                                                /
  3.      /   //      //  //   ////   /////    /////       /////  //////   /
  4.     /   //      //  //  //  //  //  //  //          //        //     /
  5.    /   //      //////  //////  /////   //      //   ////     //     /
  6.   /   //      //  //  //  //  //  //  //              //    //     /
  7.  /   //////  //  //  //  //  //  //   /////      /////     //     /
  8. /                                                                /
  9. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ v0.51ß
  10.                       © 1989 by DeltaVision Systems
  11.        Written in GfA 3.07 and Turbo-C/ST by J. Webb & E. van Herk
  12.  
  13. Is it a bird? Is it a plane? No, it's yet ANOTHER archiver. We've had SQ, 
  14. ARC, PAK, ZIP, ZOO, and now... LZH! Well, the guys on MS-DOS seem to like 
  15. it, so us ST'ers will just have to adjust, as always...
  16.  
  17. -------------------------------------------------------------------------
  18.                               INTRODUCTION
  19. -------------------------------------------------------------------------
  20.  
  21. LHarc  was  developed  for MS-Dos systems  by  somebody  called  Haruyasu 
  22. Yoshizaki  from Japan.  It compresses typical files to about 60% of  what 
  23. ARC  would  do  (e.g.  if ARC compresses it  100K,  LHarc  will  probably 
  24. compress it to about 60K).  This is just about the best ANY archiver  can 
  25. do. And for transmitting files over a telephone line that makes a hell of 
  26. a difference...
  27.  
  28. An ST version of LHarc is being written me,  Jon Webb, with a lot of help 
  29. from Bart van Herk.  This is the third release of LHarc-ST, compiled with 
  30. the brand new GfA 3.03 compiler and Turbo-C/ST.  
  31.  
  32. Neither Bart nor I take any responsibility whatsoever.  If you turn  your 
  33. 120 Meg harddisk into a C60 cassette tape, it's your own silly fault.
  34.  
  35. LHarc-ST is not completely compatible with the MS-Dos version.  We  don't 
  36. guarantee that files created on an ST can be extracted on a PC,  or  vice 
  37. versa.  But if you follow the guidelines in this document,  you shouldn't 
  38. have any problems.
  39.  
  40. -------------------------------------------------------------------------
  41.                                ! WARNING !
  42. -------------------------------------------------------------------------
  43.  
  44. LHarc-ST can NOT work with floppy disks when TurboDos is  installed!  See 
  45. the section about 'known bugs' below.
  46.  
  47. -------------------------------------------------------------------------
  48.                              STARTING LHARC
  49. -------------------------------------------------------------------------
  50.  
  51. LHarc  can be started from the desktop or from a shell.  If you like  you 
  52. can  rename  LHARC.PRG to LHARC.TTP or LHARC.TOS,  whatever  you  prefer. 
  53. LHarc knows when it has been started from the desktop.  It will allow you 
  54. to input/edit your command line, and will wait  for a keypress when done. 
  55. If  you  start LHarc without a command line,  it will display a  list  of 
  56. commands. LHarc should work fine with a standard ARCshell.
  57.  
  58. You  can get Gem to start LHarc automatically when you double-click on  a 
  59. .LZH file by going through the following steps:
  60.  
  61.      -    Highlight LHARC.PRG,
  62.      -    Select 'Install Application' from the drop-down menu,
  63.      -    Type 'LZH' and click on 'Okay',
  64.      -    Select 'Save Desktop' from the drop-down menu.
  65.  
  66. If  you  are  not  running  the new TOS 1.4  you'll  need  to  edit  your 
  67. DESKTOP.INF file with a text editor next.  Any editor will do as long  as 
  68. it can produce ASCII TEXT.  You could use 1st Word with WP mode  switched 
  69. OFF, the editor Tempus, or the capture buffer in Flash. Right down at the 
  70. bottom  of your DESKTOP.INF file you'll see a line which looks  something 
  71. like this:
  72.  
  73.      #P 03 04   LHARC.PRG@ *.LZH@ 
  74.  
  75. This  tells  Gem to start up 'LHARC.PRG' whenever you double-click  on  a 
  76. '*.LZH' file.  But Gem only stores the name of the program,  not the path 
  77. leading  to it!  So it would only be able to find LHarc if it was in  the 
  78. same folder as your .LZH file.  You must insert the path yourself. If you 
  79. have LHarc in the folder C:\COMMS\, the line would look like this:
  80.  
  81.      #P 03 04   C:\COMMS\LHARC.PRG@ *.LZH@ 
  82.  
  83. Watch out you don't change any other characters of your DESKTOP.INF file, 
  84. because  Gem is very choosy about what it finds in there.  Leave the  '@' 
  85. characters in too!
  86.  
  87. Once you've installed LHarc as an application you can double-click on any 
  88. LZH file. Gem will tell LHarc which file you double-clicked on, and LHarc 
  89. will allow you to edit your command line (e.g.  insert -V in front of the 
  90. name).
  91.  
  92. -------------------------------------------------------------------------
  93.                              INPUT AND OUTPUT
  94. -------------------------------------------------------------------------
  95.  
  96. LHarc  can  be  redirected  to a  file  or  another  device,  except  for 
  97. extraction to the screen. Output can be paused by pressing Control-S, and 
  98. resumed  with any key.  Pressing ESC or Control-C will abort the  current 
  99. operation.
  100.  
  101. -------------------------------------------------------------------------
  102.                              LHARC COMMANDS
  103. -------------------------------------------------------------------------
  104.  
  105. To use LHarc you will need to tell it what to do by giving it a  command. 
  106. ARC users will find LHarc commands quite (if not very) familiar.  If  you 
  107. do  not  know  the  purpose of archivers,  please  have  a  look  at  the 
  108. documentation which accompanies ARC from System Enhancement Associates.
  109.  
  110. Optional parameters are in square brackets [..]. LHarc will automatically 
  111. add  .LZH  to an archive name if it can't find it.  If no  drive/path  is 
  112. specified,  the current drive/path is used.  If no filespec is  specified 
  113. with any command but add, delete and rename, *.* is assumed.
  114.  
  115. *    Command....... A
  116.      Description... Add files to an archive
  117.  
  118.      Syntax........ LHARC A [path]archive[.LZH] filespecs...
  119.  
  120.      Examples...... LHARC A \document.lzh c:\docs\*.doc
  121.                     LHARC A d:\games.lzh a:\pm\pacman.*
  122.                     LHARC A c:\download\msgs *.msg
  123.                     LHARC A a:source d:myprog.c c:*.pas c:\gfa\*.GFA
  124.  
  125.      The  'A' command adds files to an archive.  If the archive does  not 
  126.      yet   exist,  it will be created first.  The file specification  may 
  127.      include  wildcards.
  128.  
  129. *    Command....... M
  130.      Description... Moves files to an archive
  131.  
  132.      Syntax........ LHARC M [path]archive[.LZH] filespecs...
  133.  
  134.      Example....... LHARC M thisdir.lzh *.*
  135.  
  136.      The  'M'  command moves files to an archive by adding  them  to  the 
  137.      archive,  and  then  deleting them from disk.  The  files  are  only 
  138.      deleted if the archive operation was successful.
  139.  
  140. *    Command....... I
  141.      Description... Extract files with Inquire
  142.  
  143.      Syntax........ LHARC I [path]archive[.LZH] filespecs...
  144.  
  145.      Examples...... LHARC I \document.lzh c:\docs\
  146.                     LHARC I d:\games
  147.                     LHARC I c:download *.msg messages\*.txt
  148.  
  149.      The  'I' command causes LHarc to display the filenames of each  file 
  150.      matching  the filespecs (or *.* if no filespec was  passed),  asking 
  151.      you  whether you want to extract this file.  Type [Y]es to  extract, 
  152.      [N]o  to continue with the next file,  [A]ll to extract the rest  of 
  153.      the files or [Q]uit to stop extracting.  If LHarc finds a file which 
  154.      already  exists,  it will ask you whether you are sure you  want  to 
  155.      extract it.  If the CRC doesn't match that of the original, you will 
  156.      be warned.
  157.  
  158. *    Command....... X
  159.      Description... Extract files from an archive
  160.  
  161.      Syntax........ LHARC X [path]archive[.LZH] filespecs
  162.  
  163.      Examples...... LHARC X \document.lzh a:\*.*
  164.                     LHARC X \sources\source d:myprog\calc*.h
  165.                     LHARC X c:games.lzh d:\pac.prg e:breakout.prg
  166.                     LHARC X b:download f:\
  167.  
  168.      The 'X' command works just like the 'I' command,  but it doesn't ask 
  169.      you  whether  you want to extract each file,  it just  extracts  all 
  170.      files matching filespec.  If a file already exists,  LHarc will warn 
  171.      you and ask you whether you're sure you want to extract it.  If  you 
  172.      don't like 'X', you can use 'E' instead (to please some ARC shells).
  173.  
  174. *    Commands...... S and P
  175.      Description... Extract files to screen or printer
  176.  
  177.      Syntax........ LHARC S [path]archive[.LZH] filespecs
  178.                     LHARC P [path]archive[.LZH] filespecs
  179.  
  180.      Examples...... LHARC S \document.lzh *.doc read_me.txt
  181.                     LHARC P \printer.lzh picture.dmp
  182.  
  183.      The  'S' command extracts files from an archive,  just like the  'X' 
  184.      command,  but  puts them on the screen instead of on disk.  The  'P' 
  185.      command sends them to the printer.  Both commands cause the files to 
  186.      be sent via BIOS, so they are not redirectable.
  187.  
  188. *    Command....... T
  189.      Description... Test files in archive
  190.  
  191.      Syntax........ LHARC T [path]archive[.LZH] filespecs...
  192.  
  193.      Examples...... LHARC T ..\badlzh importnt.doc
  194.                     LHARC T xfer.lzh *.*
  195.  
  196.      LHarc  stores lots of info about the original file in  the  archive. 
  197.      One  thing it notes down is the CRC value of that file.  CRC  stands 
  198.      for  Cyclic  Redundancy  Check,  and is a special  way  of  checking 
  199.      whether a file has been damaged or not.  If the CRC of the  original 
  200.      file matches that of the extracted file,  you can be pretty sure the 
  201.      files are identical.  The 'T' command tests files in the archive and 
  202.      reports whether the CRC value in the header matches that  calculated 
  203.      by LHarc.
  204.  
  205. *    Command....... V
  206.      Description... Verbose list of an archive
  207.  
  208.      Syntax........ LHARC V [path]archive[.LZH] filespecs...
  209.  
  210.      Examples...... LHARC V \document
  211.                     LHARC V c:\archives\sources *.C D*.PAS
  212.                     LHARC V a:games.lzh pac*.*
  213.  
  214.      The  'V'  command will show you a list of all files in  the  archive 
  215.      specified,  which match the filespecs (or all files,  if no filespec 
  216.      is given). You'll see the following information...
  217.  
  218.      - Filename:    the name of the original file
  219.      - Actual:      the length of the original file when it's unpacked
  220.      - Packed:      the number of bytes the file takes up in the archive
  221.      - Ratio:       how large the packed file is compared to the original
  222.      - Date:        date of last modification
  223.      - Time:        time of last modification
  224.      - Attr:        file attributes of the original:
  225.  
  226.                          w = Write Protected,
  227.                          h = Hidden,
  228.                          s = System,
  229.                          a = Archived.
  230.  
  231.      - CRC:         The Cyclic Redundancy Check of the file. This is used  
  232.                     to check for damages to the archive.
  233.  
  234.      - Methd:       Compression method,  Either -lh0- for an uncompressed 
  235.                     file, or -lh1- for a compressed file.
  236.  
  237. *    Command....... L
  238.      Description... Short list of an archive
  239.  
  240.      Syntax........ LHARC L [path]archive[.LZH] filespecs...
  241.  
  242.      Examples...... LHARC L \document
  243.                     LHARC L c:\archives\sources *.C D*.PAS
  244.                     LHARC L a:games.lzh pac*.*
  245.  
  246.      This command does nearly the same as 'Verbose'.  The difference: the 
  247.      filename, original size and archive comments are displayed.
  248.  
  249. *    Command....... D
  250.      Description... Delete files in an archive
  251.  
  252.      Syntax........ LHARC D [path]archive[.LZH] filespecs...
  253.  
  254.      Examples...... LHARC D msdos pc_ditto.prg
  255.                     LHARC D badlzh delete.*
  256.  
  257.      The  'D' command removes one or more entries from  the  archive.  No 
  258.      defaults are allowed here.
  259.  
  260. *    Command....... R
  261.      Description... Rename a file in an archive
  262.  
  263.      Syntax........ LHARC R [path]archive[.LZH] oldNAME newNAME
  264.  
  265.      Example....... LHARC R upgrade.lzh version1.prg version2.prg
  266.  
  267.      This command changes the name of ONE SINGLE file in an archive.  You 
  268.      CAN'T use wildcards here!
  269.  
  270. -------------------------------------------------------------------------
  271.                                 SWITCHES
  272. -------------------------------------------------------------------------
  273.  
  274. You  can influence the behaviour of LHarc by adding one or more  switches 
  275. after the command character. These switches are valid:
  276.  
  277.      H    Hold  after command,  will tell LHarc to pause for  a  keypress 
  278.           after it has done whatever it was supposed to do.  Because some 
  279.           people might be using LHarc for running a BBS,  a thirty second 
  280.           timeout  has been added,  so LHarc will exit after  30  seconds 
  281.           even  if you don't press a key.  When started from the  desktop 
  282.           LHarc will always ask for a keypress.
  283.  
  284.      B    keep  Backup of archive.  If you don't trust LHarc you can  get 
  285.           it to leave the 'old' copy of the archive on disk.  It won't be 
  286.           deleted, the extension will just be changed to '.BAK'.
  287.  
  288.      N    No  compression,  will  cause LHarc to store the  file  in  the 
  289.           archive without compressing it.  These files are displayed with 
  290.           method  '-lh0-' in the verbose list.  The CRC saved is a  dummy 
  291.           (Hex 1234).
  292.  
  293.      O    Overwrite existing files.  If you add this switch,  LHarc won't 
  294.           ask  you  whether you want to overwrite the file  about  to  be 
  295.           extracted if it already exists. The old file will be deleted.
  296.  
  297.      F    Disable  Floppy/TurboDos check.  This switch will override  the 
  298.           checking  for floppy operations with  TurboDos  installed.  You 
  299.           might have a newer version of TurboDos than I have,  so you can 
  300.           switch the checking off here.
  301.  
  302.      C    Add  Comments.  LHarc  can  add comments to  each  file  in  an 
  303.           archive. These will be displayed when you extract, list, update 
  304.           the  archive  etc.  By  adding this switch  while  updating  or 
  305.           creating an archive LHarc will prompt you for a comment.
  306.  
  307. Example:  You want to extract TEST.LZH, and you don't care about existing 
  308. files... The command would be:
  309.  
  310.      LHARC XO TEST.LZH
  311.  
  312. To  get  a verbose list of the contents of TEST.LZH,  and pausing  for  a 
  313. keypress after the list has been displayed, the command would be:
  314.  
  315.      LHARC VH TEST.LZH
  316.  
  317. -------------------------------------------------------------------------
  318.                      ERRORLEVELS AND TEMPORARY FILES
  319. -------------------------------------------------------------------------
  320.  
  321. LHarc passes a value back to the program it was called from.  The desktop 
  322. disregards this value, but other programs might find it useful. The value 
  323. (usually  called  an 'error level') depends on whether  the  command  was 
  324. executed successfully. The following error levels are used:
  325.  
  326.      0    Okay, no error,
  327.      1    The  given command wasn't recognised,  or the user aborted  the 
  328.           operation,
  329.      2    The specified archive wasn't found,
  330.      3    GemDos reported a read error. Probably a faulty disk,
  331.      4    GemDos reported a write error. Same as above,
  332.      5    A CRC error was found in the archive tested/extracted,
  333.      6    The archive has a bad header in it, probably damaged,
  334.      7    An internal error occured in LHarc.
  335.  
  336. Any  other error levels should be interpreted as  program  errors.  LHarc 
  337. creates a file called 'LHARC.$$$' when updating an archive.  This file is 
  338. later renamed to the actual archive name.  If an error occurs during  the 
  339. operation,  this file is left on disk and can be deleted.  If a file with 
  340. this  name already exists,  and an archive is updated,  the file will  be 
  341. deleted without warning!
  342.  
  343. -------------------------------------------------------------------------
  344.                DIFFERENCES COMPARED TO THE MS-DOS VERSION
  345. -------------------------------------------------------------------------
  346.  
  347. Like  I  said,  LHarc-ST  is not completely compatible  with  the  MS-DOS 
  348. version. Some things to keep in mind:
  349.  
  350.      -    LHarc-ST  has  been tested with archives  created  by  LHarc-PC 
  351.           v1.12 and vice versa,
  352.  
  353.      -    LHarc-ST can handle files with full pathnames,  but will  strip 
  354.           the  path  off when extracting.  LHarc-ST  can't  handle  self-
  355.           extracting archives (.COM/.EXE).
  356.  
  357.      -    For  -lh0- type files (which are normally VERY small),  no  CRC 
  358.           check is done during decompression. All -lh1- files are checked 
  359.           of  course.  If you specify 'N'o compression when adding to  an 
  360.           archive, the CRC is a dummy (hex 1234).
  361.  
  362.      -    When  extracting  a file from an archive,  the  attributes  are 
  363.           disregarded.  I  don't like the thought of  archivers  creating 
  364.           hidden read-only system files. 
  365.  
  366.      -    The  archive  comments might not work with future  versions  of 
  367.           LHarc on the PC or any other system. I've used a rather illegal 
  368.           method of adding comments,  but the PC version doesn't seem  to 
  369.           mind. Archives which don't contain comments should work fine in 
  370.           any case.
  371.  
  372.      -    LHarc has a maximum of 100 files per archive at the moment.
  373.  
  374. -------------------------------------------------------------------------
  375.                                KNOWN BUGS
  376. -------------------------------------------------------------------------
  377.  
  378. LHarc cannot work with floppy disks if TurboDos is installed.  This is  a 
  379. bug in all programs written in Turbo-C. Before doing anything on a floppy 
  380. LHarc will check to see whether TurboDos is installed and issue an  error 
  381. if  it  thinks it will have problems.  If you try anyway  (with  the  'f' 
  382. switch) your machine will probably lock up.  LHarc will work fine without 
  383. TurboDos, on harddisks and with any version of TOS.
  384.  
  385. -------------------------------------------------------------------------
  386.             BUG REPORTS, REGISTRATION AND DISTRIBUTION POLICY
  387. -------------------------------------------------------------------------
  388.  
  389. If you find any bugs,  other than the one above, please let us know. We'd 
  390. like to know a number of things:
  391.  
  392.      - The version number of LHarc, PC or ST?
  393.      - The command line used to call LHarc,
  394.      - Information about WHAT was happening when the bug occurred,
  395.      - Information about the files you were adding/extracting,
  396.      - Information about the archive you were adding to/extracting from,
  397.      - Was that archive created on a PC or ST? By what version of LHarc?
  398.      - What machine you're running (520 ST, 1040 ST, Mega-2 etc),
  399.      - The version number or default date of your TOS,
  400.      - Where you called LHarc from (DeskTop, NeoDesk, PCommand etc.),
  401.      - How much free memory you had when you started LHarc.
  402.  
  403. Please fill in as much info as you can.  If possible,  tell me how I  can 
  404. reproduce the error. You can reach me by normal mail at:
  405.  
  406.      DeltaVision Systems,
  407.      I.B.B.-laan 37,
  408.      3582 VE Utrecht,
  409.      The Netherlands.
  410.  
  411. or leave a message to Jon Webb at...
  412.  
  413.      Computershop Utrecht BBS (FidoNet 2:282/350),
  414.      Telephone : Holland (0)30 - 660 487,
  415.      at 300, 1200 or 2400 bps, 24 hours per day,
  416.      your Sysop is Eddy Emck.
  417.  
  418. If you enjoy using LHarc-ST and would like to receive the latest  version 
  419. (plus utilities) on-disk,  send a cheque or postal order for HFL 20,- (or 
  420. more 8-]) made payable to Jon Webb to the address above.  Include a  note 
  421. with  your name,  address,  phone number,  which version of LHarc-ST  you 
  422. already  have,  and whether you'd like the newest version right  away  or 
  423. prefer to wait for the next update.  Registered users will receive a note 
  424. when each future update is released,  and can obtain a copy for just  the 
  425. cost of a disk + p&p.
  426.  
  427. LHarc-ST may be used,  copied and made available for download as long  as 
  428. you stick to these rules:
  429.  
  430.      -    You ALWAYS include the documentation,
  431.      -    You  do  NOT modify the program or documentation  in  any  way, 
  432.           except for translation of the documentation,
  433.      -    You  do  NOT charge a fee other than nominal on-line  time  and 
  434.           copying charges.
  435.  
  436. and  PLEASE show the version number of LHarc with the  file  name.  Thank 
  437. you!
  438.  
  439. -------------------------------------------------------------------------
  440.                                 HAVE FUN!
  441. --------------------------------------------------------------------------
  442.  
  443.